Add docs.

2006-04-24  Matthias Clasen  <mclasen@redhat.com>

	* gtk/gtkprintunixdialog.c: Add docs.

	* gtk/gtkstatusicon.c (gtk_status_icon_get_visible): Typo fix.

diff --git a/ChangeLog b/ChangeLog
index 6c423b2c724feccbe66fc7fb23971bb12f41aede..ba729de011dea4e0e2f43623b03241d47a3da613 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,9 @@
+2006-04-24  Matthias Clasen  <mclasen@redhat.com>
+
+       * gtk/gtkprintunixdialog.c: Add docs.
+
+       * gtk/gtkstatusicon.c (gtk_status_icon_get_visible): Typo fix.
+
 2006-04-24  Alexander Larsson  <alexl@redhat.com>
 
        * gtk/gtkprinter.c:

diff --git a/ChangeLog.pre-2-10 b/ChangeLog.pre-2-10
index 6c423b2c724feccbe66fc7fb23971bb12f41aede..ba729de011dea4e0e2f43623b03241d47a3da613 100644 (file)
--- a/ChangeLog.pre-2-10
+++ b/ChangeLog.pre-2-10
@@ -1,3 +1,9 @@
+2006-04-24  Matthias Clasen  <mclasen@redhat.com>
+
+       * gtk/gtkprintunixdialog.c: Add docs.
+
+       * gtk/gtkstatusicon.c (gtk_status_icon_get_visible): Typo fix.
+
 2006-04-24  Alexander Larsson  <alexl@redhat.com>
 
        * gtk/gtkprinter.c:

diff --git a/gtk/gtkprintunixdialog.c b/gtk/gtkprintunixdialog.c
index 83d4901dcc18c6a1b785a0e2fb868ce0b8cb0438..66dea58772c86cbab96db83594ef79a1f6810d79 100644 (file)
--- a/gtk/gtkprintunixdialog.c
+++ b/gtk/gtkprintunixdialog.c
@@ -2366,6 +2366,16 @@ gtk_print_unix_dialog_new (const gchar *title,
   return result;
 }
 
+/**
+ * gtk_print_unix_dialog_get_selected_printer:
+ * @dialog: a #GtkPrintUnixDialog
+ * 
+ * Gets the currently selected printer.
+ * 
+ * Returns: the currently selected printer
+ * 
+ * Since: 2.10
+ */
 GtkPrinter *
 gtk_print_unix_dialog_get_selected_printer (GtkPrintUnixDialog *dialog)
 {
@@ -2374,6 +2384,15 @@ gtk_print_unix_dialog_get_selected_printer (GtkPrintUnixDialog *dialog)
   return dialog->priv->current_printer;
 }
 
+/**
+ * gtk_print_unix_dialog_set_page_setup:
+ * @dialog: a #GtkPrintUnixDialog
+ * @page_setup: a #GtkPageSetup
+ * 
+ * Sets the page setup of the #GtkPrintUnixDialog.
+ *
+ * Since: 2.10
+ */
 void
 gtk_print_unix_dialog_set_page_setup (GtkPrintUnixDialog *dialog,
                                      GtkPageSetup       *page_setup)
@@ -2390,6 +2409,16 @@ gtk_print_unix_dialog_set_page_setup (GtkPrintUnixDialog *dialog,
     }
 }
 
+/**
+ * gtk_print_unix_dialog_get_page_setup:
+ * @dialog: a #GtkPrintUnixDialog
+ * 
+ * Gets the page setup that is used by the #GtkPrintUnixDialog.
+ * 
+ * Returns: the page setup of @dialog.
+ *
+ * Since: 2.10
+ */
 GtkPageSetup *
 gtk_print_unix_dialog_get_page_setup (GtkPrintUnixDialog *dialog)
 {
@@ -2398,6 +2427,16 @@ gtk_print_unix_dialog_get_page_setup (GtkPrintUnixDialog *dialog)
   return dialog->priv->page_setup;
 }
 
+/**
+ * gtk_print_unix_dialog_set_current_page:
+ * @dialog: a #GtkPrintUnixDialog
+ * @current_page: the current page number.
+ * 
+ * Sets the current page number. If @current_page is not -1, this enables
+ * the current page choice for the range of pages to print.
+ *
+ * Since: 2.10
+ */
 void
 gtk_print_unix_dialog_set_current_page (GtkPrintUnixDialog *dialog,
                                        gint                current_page)
@@ -2415,6 +2454,16 @@ gtk_print_unix_dialog_set_current_page (GtkPrintUnixDialog *dialog,
     }
 }
 
+/**
+ * gtk_print_unix_dialog_get_current_page:
+ * @dialog: a #GtkPrintUnixDialog
+ * 
+ * Gets the current page of the #GtkPrintDialog.
+ * 
+ * Returns: the current page of @dialog
+ * 
+ * Since: 2.10
+ */
 gint
 gtk_print_unix_dialog_get_current_page (GtkPrintUnixDialog *dialog)
 {
@@ -2467,6 +2516,17 @@ set_active_printer (GtkPrintUnixDialog *dialog,
   return FALSE;
 }
 
+/**
+ * gtk_print_unix_dialog_set_settings:
+ * @dialog: a #GtkPrintUnixDialog
+ * @settings: a #GtkPrintSettings, or %NULL
+ * 
+ * Sets the #GtkPrintSettings for the #GtkPrintUnixDialog. Typically,
+ * this is used to restore saved print settings from a previous print
+ * operation before the print dialog is shown.
+ * 
+ * Since: 2.10
+ **/
 void
 gtk_print_unix_dialog_set_settings (GtkPrintUnixDialog *dialog,
                                    GtkPrintSettings   *settings)
@@ -2515,6 +2575,19 @@ gtk_print_unix_dialog_set_settings (GtkPrintUnixDialog *dialog,
   g_object_notify (G_OBJECT (dialog), "print-settings");
 }
 
+/**
+ * gtk_print_unix_dialog_get_settings:
+ * @dialog: a #GtkPrintUnixDialog
+ * 
+ * Gets a new #GtkPrintSettings object that represents the
+ * current values in the print dialog. Note that this creates a
+ * <emphasis>new object</emphasis>, and you need to unref it
+ * if don't want to keep it.
+ * 
+ * Returns: a new #GtkPrintSettings object with the values from @dialog
+ *
+ * Since: 2.10
+ */
 GtkPrintSettings *
 gtk_print_unix_dialog_get_settings (GtkPrintUnixDialog *dialog)
 {

diff --git a/gtk/gtkstatusicon.c b/gtk/gtkstatusicon.c
index 731e182d585ff26a23791404793c714c544d2bcf..b38f7cde72ca67f09cb4e94dfcaeda415d9b8725 100755 (executable)
--- a/gtk/gtkstatusicon.c
+++ b/gtk/gtkstatusicon.c
@@ -1366,7 +1366,7 @@ gtk_status_icon_set_visible (GtkStatusIcon *status_icon,
  * gtk_status_icon_get_visible:
  * @status_icon: a #GtkStatusIcon
  * 
- * Returns wether the status icon is visible or not. 
+ * Returns whether the status icon is visible or not. 
  * Note that being visible does not guarantee that 
  * the user can actually see the icon, see also 
  * gtk_status_icon_is_embedded().